is_read_only

audio_form object

This method returns a value indicating whether the specified control is read only.

bool is_read_only(int control_id)

Parameters:
control_id
The ID of the control you wish to check.

Return value:
true if the control is read only, false if the control can be modified, or if an error occurred.

Remarks:
This method will only function on text fields and checkboxes.

Example:

// Make a simple form with a few buttons and a text field.

#include "form.bgt"

audio_form form;

void main()
{
form.create_window("Example Form", true);
int test=form.create_input_box("Test", "", "", 0, false, false);
int ok=form.create_button("OK");
int cancel=form.create_button("E&xit");
while(true)
{
form.monitor();
wait(5);
if(form.is_pressed(ok))
{
if(form.is_read_only(test))
{
alert("Information", "The text field is read only.");
}
else
{
alert("Information", "The text field can be modified.");
}
exit();
}
if(form.is_pressed(cancel))
{
exit();
}
if((key_down(KEY_LMENU))&&(key_pressed(KEY_F4)))
{
exit();
}
}
}